<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class ToolbarComponent</title>

	<script type="text/javascript" src="resources/combined.js?394153670"></script>
	<script type="text/javascript" src="elementlist.js?1800566221"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-abismo.html">abismo<span></span></a>
						<ul>
				<li><a href="package-abismo.admin.html">admin</a>
						</li>
				<li><a href="package-abismo.home.html">home</a>
						</li>
				<li><a href="package-abismo.images.html">images</a>
						</li>
				<li><a href="package-abismo.projects.html">projects</a>
						</li>
				<li><a href="package-abismo.Services.html">Services</a>
						</li>
				<li><a href="package-abismo.studio.html">studio</a>
						</li>
				<li><a href="package-abismo.tenders.html">tenders</a>
						</li>
				<li><a href="package-abismo.users.html">users</a>
						</li>
				<li><a href="package-abismo.videos.html">videos</a>
						</li>
				<li><a href="package-abismo.view.html">view<span></span></a>
						<ul>
				<li><a href="package-abismo.view.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-app.html">app<span></span></a>
						<ul>
				<li><a href="package-app.Config.html">Config<span></span></a>
						<ul>
				<li><a href="package-app.Config.Schema.html">Schema</a>
						</li>
							</ul></li>
				<li><a href="package-app.Model.html">Model<span></span></a>
						<ul>
				<li><a href="package-app.Model.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-app.Model.debug.kit.html">kit</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-app.View.html">View<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.html">Helper<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.views.html">views<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.views.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li></ul></li></ul></li></ul></li></ul></li>
				<li><a href="package-cake.html">cake<span></span></a>
						<ul>
				<li><a href="package-cake.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-cake.debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-cake.debug.kit.panels.html">panels</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li class="active"><a href="package-debug.html">debug<span></span></a>
						<ul>
				<li class="active"><a href="package-debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-debug.kit.components.html">components</a>
						</li>
				<li class="active"><a href="package-debug.kit.controllers.html">controllers<span></span></a>
						<ul>
				<li class="active"><a href="package-debug.kit.controllers.components.html">components</a>
						</li>
							</ul></li>
				<li><a href="package-debug.kit.Lib.html">Lib</a>
						</li>
				<li><a href="package-debug.kit.models.html">models<span></span></a>
						<ul>
				<li><a href="package-debug.kit.models.behaviors.html">behaviors</a>
						</li>
							</ul></li>
				<li><a href="package-debug.kit.vendors.html">vendors</a>
						</li>
				<li><a href="package-debug.kit.views.html">views<span></span></a>
						<ul>
				<li><a href="package-debug.kit.views.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li><a href="package-localized.html">localized</a>
						</li>
				<li><a href="package-Localized.html">Localized<span></span></a>
						<ul>
				<li><a href="package-localized.tests.html">tests<span></span></a>
						<ul>
				<li><a href="package-localized.tests.cases.html">cases<span></span></a>
						<ul>
				<li><a href="package-localized.tests.cases.libs.html">libs</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-Localized.Validation.html">Validation</a>
						</li>
							</ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-ToolbarComponent.html">ToolbarComponent</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-debug.kit.controllers.components.html" title="Summary of debug\kit\controllers\components"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class ToolbarComponent</h1>


	<div class="description">
	
<p>DebugKit DebugToolbar Component</p>

<p>Copyright 2005-2010, Cake Software Foundation, Inc. (<a
href="http://cakefoundation.org">http://cakefoundation.org</a>)</p>

<p>Licensed under The MIT License Redistributions of files must retain the above
copyright notice.</p>

	</div>

	<dl class="tree">
		<dd style="padding-left:0px">
Component
			
			
		</dd>
		<dd style="padding-left:30px">
			<img src="resources/inherit.png" alt="Extended by" />
<b><span>ToolbarComponent</span></b>			
			 implements 
<span>CakeEventListener</span>
			
			
		</dd>
	</dl>








	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-debug.html">debug</a>\<a href="package-debug.kit.html">kit</a>\<a href="package-debug.kit.controllers.html">controllers</a>\<a href="package-debug.kit.controllers.components.html">components</a><br />

				<b>Copyright:</b>
				Copyright 2005-2010, Cake Software Foundation, Inc. (<a
href="http://cakefoundation.org">http://cakefoundation.org</a>)<br />
				<b>License:</b>
				<a href="MIT">License (http://www.opensource.org/licenses/mit-license.php)</a><br />
				<b>Since:</b>
				DebugKit 0.1<br />
				<b>Link:</b>
				<a href="http://cakephp.org">http://cakephp.org</a><br />
		<b>Located at</b> <a href="source-class-ToolbarComponent.html#10-487" title="Go to source code">Plugin/DebugKit/Controller/Component/ToolbarComponent.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-ToolbarComponent.html#118-166" title="Go to source code">__construct</a>( <span>ComponentCollection <var>$collection</var></span>, <span>mixed <var>$settings</var> = <span class="php-keyword1">array</span>()</span> )</code>

		<div class="description short">
			
<p>Constructor</p>

		</div>

		<div class="description detailed hidden">
			
<p>Constructor</p>

<p>If debug is off the component will be disabled and not do any further time
tracking or load the toolbar helper.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="implementedEvents" id="_implementedEvents">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_implementedEvents">#</a>
		<code><a href="source-class-ToolbarComponent.html#168-219" title="Go to source code">implementedEvents</a>( )</code>

		<div class="description short">
			
<p>Register all the timing handlers for core events.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Register all the timing handlers for core events.</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="initialize" id="_initialize">

		<td class="attributes"><code>
			 public 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_initialize">#</a>
		<code><a href="source-class-ToolbarComponent.html#221-231" title="Go to source code">initialize</a>( <span>Controller <var>$controller</var></span> )</code>

		<div class="description short">
			
<p>Initialize callback. If automatically disabled, tell component collection
about the state.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Initialize callback. If automatically disabled, tell component collection
about the state.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="_makePanelList" id="__makePanelList">

		<td class="attributes"><code>
			 protected 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__makePanelList">#</a>
		<code><a href="source-class-ToolbarComponent.html#233-260" title="Go to source code">_makePanelList</a>( <span>array <var>$userPanels</var></span> )</code>

		<div class="description short">
			
<p>Go through user panels and remove default panels as indicated.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Go through user panels and remove default panels as indicated.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$userPanels</var></dt>
					<dd><code>array</code><br>$userPanels The list of panels ther user has added removed.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br>Array of panels to use.<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="startup" id="_startup">

		<td class="attributes"><code>
			 public 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_startup">#</a>
		<code><a href="source-class-ToolbarComponent.html#262-279" title="Go to source code">startup</a>( <span>Controller <var>$controller</var></span> )</code>

		<div class="description short">
			
<p>Component Startup</p>

		</div>

		<div class="description detailed hidden">
			
<p>Component Startup</p>




				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="beforeRedirect" id="_beforeRedirect">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_beforeRedirect">#</a>
		<code><a href="source-class-ToolbarComponent.html#281-298" title="Go to source code">beforeRedirect</a>( <span>Controller <var>$controller</var></span>, <span>mixed <var>$url</var></span>, <span>mixed <var>$status</var> = <span class="php-keyword1">null</span></span>, <span>mixed <var>$exit</var> = <span class="php-keyword1">true</span></span> )</code>

		<div class="description short">
			
<p>beforeRedirect callback</p>

		</div>

		<div class="description detailed hidden">
			
<p>beforeRedirect callback</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="beforeRender" id="_beforeRender">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_beforeRender">#</a>
		<code><a href="source-class-ToolbarComponent.html#300-351" title="Go to source code">beforeRender</a>( <span>Controller <var>$controller</var></span> )</code>

		<div class="description short">
			
<p>beforeRender callback</p>

		</div>

		<div class="description detailed hidden">
			
<p>beforeRender callback</p>

<p>Calls beforeRender on all the panels and set the aggregate to the
controller.</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="loadState" id="_loadState">

		<td class="attributes"><code>
			 public 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_loadState">#</a>
		<code><a href="source-class-ToolbarComponent.html#353-365" title="Go to source code">loadState</a>( <span>integer <var>$key</var></span> )</code>

		<div class="description short">
			
<p>Load a toolbar state from cache</p>

		</div>

		<div class="description detailed hidden">
			
<p>Load a toolbar state from cache</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$key</var></dt>
					<dd><code>integer</code><br>$key</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="_createCacheConfig" id="__createCacheConfig">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__createCacheConfig">#</a>
		<code><a href="source-class-ToolbarComponent.html#367-384" title="Go to source code">_createCacheConfig</a>( )</code>

		<div class="description short">
			
<p>Create the cache config for the history</p>

		</div>

		<div class="description detailed hidden">
			
<p>Create the cache config for the history</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="_gatherVars" id="__gatherVars">

		<td class="attributes"><code>
			 protected 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__gatherVars">#</a>
		<code><a href="source-class-ToolbarComponent.html#386-416" title="Go to source code">_gatherVars</a>( <span>Controller <var>$controller</var></span> )</code>

		<div class="description short">
			
<p>collects the panel contents</p>

		</div>

		<div class="description detailed hidden">
			
<p>collects the panel contents</p>




				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br>Array of all panel beforeRender()<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="_loadPanels" id="__loadPanels">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__loadPanels">#</a>
		<code><a href="source-class-ToolbarComponent.html#418-439" title="Go to source code">_loadPanels</a>( <span>mixed <var>$panels</var></span>, <span>mixed <var>$settings</var></span> )</code>

		<div class="description short">
			
<p>Load Panels used in the debug toolbar</p>

		</div>

		<div class="description detailed hidden">
			
<p>Load Panels used in the debug toolbar</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="_saveState" id="__saveState">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__saveState">#</a>
		<code><a href="source-class-ToolbarComponent.html#441-486" title="Go to source code">_saveState</a>( <span>Controller <var>$controller</var></span>, <span>array <var>$vars</var></span> )</code>

		<div class="description short">
			
<p>Save the current state of the toolbar varibles to the cache file.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Save the current state of the toolbar varibles to the cache file.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$controller</var></dt>
					<dd><code>object</code><br>$controller Controller instance</dd>
					<dt><var>$vars</var></dt>
					<dd><code>array</code><br>$vars Vars to save.</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	</table>












	<table class="summary" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="settings" id="$settings">
		<td class="attributes"><code>
			public  
			array
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#27-39" title="Go to source code"><var>$settings</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>(
	<span class="php-quote">'forceEnable'</span> =&gt; <span class="php-keyword1">false</span>,
	<span class="php-quote">'autoRun'</span> =&gt; <span class="php-keyword1">true</span>
)</code></td>
		<td class="description"><div>
			<a href="#$settings" class="anchor">#</a>

			<div class="description short">
				
<p>Settings for the Component</p>

			</div>

			<div class="description detailed hidden">
				
<p>Settings for the Component</p>

<ul>
	<li>forceEnable - Force the toolbar to display even if debug == 0. Default =
	false</li>

	<li>autoRun - Automatically display the toolbar. If set to false, toolbar
	display can be triggered by adding <code>?debug=true</code> to your URL.</li>
</ul>


			</div>
		</div></td>
	</tr>
	<tr data-order="controller" id="$controller">
		<td class="attributes"><code>
			public  
			object
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#41-46" title="Go to source code"><var>$controller</var></a>
		</td>
		<td class="value"><code></code></td>
		<td class="description"><div>
			<a href="#$controller" class="anchor">#</a>

			<div class="description short">
				
<p>Controller instance reference</p>

			</div>

			<div class="description detailed hidden">
				
<p>Controller instance reference</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="components" id="$components">
		<td class="attributes"><code>
			public  
			array
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#48-53" title="Go to source code"><var>$components</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>(<span class="php-quote">'RequestHandler'</span>, <span class="php-quote">'Session'</span>)</code></td>
		<td class="description"><div>
			<a href="#$components" class="anchor">#</a>

			<div class="description short">
				
<p>Components used by DebugToolbar</p>

			</div>

			<div class="description detailed hidden">
				
<p>Components used by DebugToolbar</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_defaultPanels" id="$_defaultPanels">
		<td class="attributes"><code>
			protected  
			array
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#55-71" title="Go to source code"><var>$_defaultPanels</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>(
	<span class="php-quote">'DebugKit.History'</span>,
	<span class="php-quote">'DebugKit.Session'</span>,
	<span class="php-quote">'DebugKit.Request'</span>,
	<span class="php-quote">'DebugKit.SqlLog'</span>,
	<span class="php-quote">'DebugKit.Timer'</span>,
	<span class="php-quote">'DebugKit.Log'</span>,
	<span class="php-quote">'DebugKit.Variables'</span>,
	<span class="php-quote">'DebugKit.Environment'</span>,
	<span class="php-quote">'DebugKit.Include'</span>
)</code></td>
		<td class="description"><div>
			<a href="#$_defaultPanels" class="anchor">#</a>

			<div class="description short">
				
<p>The default panels the toolbar uses. which panels are used can be configured
when attaching the component</p>

			</div>

			<div class="description detailed hidden">
				
<p>The default panels the toolbar uses. which panels are used can be configured
when attaching the component</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="panels" id="$panels">
		<td class="attributes"><code>
			public  
			array
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#73-78" title="Go to source code"><var>$panels</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$panels" class="anchor">#</a>

			<div class="description short">
				
<p>Loaded panel objects.</p>

			</div>

			<div class="description detailed hidden">
				
<p>Loaded panel objects.</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="javascript" id="$javascript">
		<td class="attributes"><code>
			public  
			array
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#80-88" title="Go to source code"><var>$javascript</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>(
	<span class="php-quote">'jquery'</span> =&gt; <span class="php-quote">'DebugKit.jquery'</span>,
	<span class="php-quote">'libs'</span> =&gt; <span class="php-quote">'DebugKit.js_debug_toolbar'</span>
)</code></td>
		<td class="description"><div>
			<a href="#$javascript" class="anchor">#</a>

			<div class="description short">
				
<p>javascript files component will be using</p>

			</div>

			<div class="description detailed hidden">
				
<p>javascript files component will be using</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="css" id="$css">
		<td class="attributes"><code>
			public  
			array
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#90-95" title="Go to source code"><var>$css</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>(<span class="php-quote">'DebugKit.debug_toolbar.css'</span>)</code></td>
		<td class="description"><div>
			<a href="#$css" class="anchor">#</a>

			<div class="description short">
				
<p>CSS files component will be using</p>

			</div>

			<div class="description detailed hidden">
				
<p>CSS files component will be using</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="cacheKey" id="$cacheKey">
		<td class="attributes"><code>
			public  
			string
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#97-102" title="Go to source code"><var>$cacheKey</var></a>
		</td>
		<td class="value"><code><span class="php-quote">'toolbar_cache'</span></code></td>
		<td class="description"><div>
			<a href="#$cacheKey" class="anchor">#</a>

			<div class="description short">
				
<p>CacheKey used for the cache file.</p>

			</div>

			<div class="description detailed hidden">
				
<p>CacheKey used for the cache file.</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="cacheDuration" id="$cacheDuration">
		<td class="attributes"><code>
			public  
			string
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#104-109" title="Go to source code"><var>$cacheDuration</var></a>
		</td>
		<td class="value"><code><span class="php-quote">'+4 hours'</span></code></td>
		<td class="description"><div>
			<a href="#$cacheDuration" class="anchor">#</a>

			<div class="description short">
				
<p>Duration of the debug kit history cache</p>

			</div>

			<div class="description detailed hidden">
				
<p>Duration of the debug kit history cache</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="enabled" id="$enabled">
		<td class="attributes"><code>
			public  
			boolean
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarComponent.html#111-116" title="Go to source code"><var>$enabled</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">true</span></code></td>
		<td class="description"><div>
			<a href="#$enabled" class="anchor">#</a>

			<div class="description short">
				
<p>Status whether component is enable or disable</p>

			</div>

			<div class="description detailed hidden">
				
<p>Status whether component is enable or disable</p>


			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
